/**
 * Collaborative Story Development Web Application (CSDApp) 
 * Copyright Anton Strack 2014
 *
 * This file is part of Collaborative Story Development Application (CSDApp).
 *
 * CSDApp is free software: you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or any later version.
 *
 * CSDApp is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * CSDApp. If not, see <http://www.gnu.org/licenses/>.
 *
 */
package csdwa;

/**
 * This interface defines a resource that should notify the notificationManager
 * when an action is preformed on it.
 *
 * @author Anton Strack
 */
public interface CsdwaNotifiable {

    /**
     * This method will get the id of the resource being recorded
     *
     * @return id of the resource
     */
    public int getId();

    /**
     * This method will get the state id of the resource being recorded.
     *
     * @return the state id of the resource
     */
    public int getStateId();

    /**
     * This method will get the resource type id of the resource being recorded
     *
     * @return the resource type id
     */
    public int getResourceTypeId();

    /**
     * This method will get the name of the resource being recorded.
     *
     * @return the resource name
     */
    public String getName();
}
